﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Interface IVariableDictionary&lt;V&gt;
   </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Interface IVariableDictionary&lt;V&gt;
   ">
    <meta name="generator" content="docfx 2.52.0.0">
    
    <link rel="shortcut icon" href="../api/images/favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> 
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    <script type="text/javascript" async="" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML"></script>
    
    
    
  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>
              
              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../api/images/favicon.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>
        
        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="SpiceSharp.Simulations.IVariableDictionary`1">
  
  
  <h1 id="SpiceSharp_Simulations_IVariableDictionary_1" data-uid="SpiceSharp.Simulations.IVariableDictionary`1" class="text-break">Interface IVariableDictionary&lt;V&gt;
  </h1>
  <div class="markdown level0 summary"><p>A template for a dictionary of strongly typed variables.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <span class="xref">System.Collections.Generic.IReadOnlyDictionary&lt;System.String, V&gt;.ContainsKey(System.String)</span>
    </div>
    <div>
      <span class="xref">System.Collections.Generic.IReadOnlyDictionary&lt;System.String, V&gt;.TryGetValue(System.String, V)</span>
    </div>
    <div>
      <span class="xref">System.Collections.Generic.IReadOnlyDictionary&lt;System.String, V&gt;.Item[System.String]</span>
    </div>
    <div>
      <span class="xref">System.Collections.Generic.IReadOnlyDictionary&lt;System.String, V&gt;.Keys</span>
    </div>
    <div>
      <span class="xref">System.Collections.Generic.IReadOnlyDictionary&lt;System.String, V&gt;.Values</span>
    </div>
    <div>
      <span class="xref">System.Collections.Generic.IReadOnlyCollection&lt;System.Collections.Generic.KeyValuePair&lt;System.String, V&gt;&gt;.Count</span>
    </div>
    <div>
      <span class="xref">System.Collections.Generic.IEnumerable&lt;System.Collections.Generic.KeyValuePair&lt;System.String, V&gt;&gt;.GetEnumerator()</span>
    </div>
    <div>
      <span class="xref">System.Collections.IEnumerable.GetEnumerator()</span>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="SpiceSharp.Simulations.html">SpiceSharp.Simulations</a></h6>
  <h6><strong>Assembly</strong>: SpiceSharp.dll</h6>
  <h5 id="SpiceSharp_Simulations_IVariableDictionary_1_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public interface IVariableDictionary&lt;V&gt; : IReadOnlyDictionary&lt;string, V&gt;, IReadOnlyCollection&lt;KeyValuePair&lt;string, V&gt;&gt;, IEnumerable&lt;KeyValuePair&lt;string, V&gt;&gt;, IEnumerable where V : IVariable</code></pre>
  </div>
  <h5 class="typeParameters">Type Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="parametername">V</span></td>
        <td><p>The variable type.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="SpiceSharp_Simulations_IVariableDictionary_1_remarks"><strong>Remarks</strong></h5>
  <div class="markdown level0 remarks"><p>This can be used to map variables into a solver.</p>
</div>
  <h3 id="properties">Properties
  </h3>
  <a id="SpiceSharp_Simulations_IVariableDictionary_1_Comparer_" data-uid="SpiceSharp.Simulations.IVariableDictionary`1.Comparer*"></a>
  <h4 id="SpiceSharp_Simulations_IVariableDictionary_1_Comparer" data-uid="SpiceSharp.Simulations.IVariableDictionary`1.Comparer">Comparer</h4>
  <div class="markdown level1 summary"><p>Gets the comparer used for comparing variable names.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">IEqualityComparer&lt;string&gt; Comparer { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Collections.Generic.IEqualityComparer</span>&lt;<span class="xref">System.String</span>&gt;</td>
        <td><p>The comparer.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
  </h3>
  <a id="SpiceSharp_Simulations_IVariableDictionary_1_Add_" data-uid="SpiceSharp.Simulations.IVariableDictionary`1.Add*"></a>
  <h4 id="SpiceSharp_Simulations_IVariableDictionary_1_Add_System_String__0_" data-uid="SpiceSharp.Simulations.IVariableDictionary`1.Add(System.String,`0)">Add(String, V)</h4>
  <div class="markdown level1 summary"><p>Adds a variable to the dictionary.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">void Add(string id, V variable)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">id</span></td>
        <td><p>The identifier.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">V</span></td>
        <td><span class="parametername">variable</span></td>
        <td><p>The variable.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="exceptions">Exceptions</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Condition</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.ArgumentNullException</span></td>
        <td><p>Thrown if <code data-dev-comment-type="paramref" class="paramref">id</code> or <code data-dev-comment-type="paramref" class="paramref">variable</code> is <code>null</code>.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.ArgumentException</span></td>
        <td><p>Thrown if a variable with the same identifier already exists.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="extensionmethods">Extension Methods</h3>
  <div>
      <a class="xref" href="SpiceSharp.Utility.html#SpiceSharp_Utility_ThrowIfNull__1___0_System_String_">Utility.ThrowIfNull&lt;T&gt;(T, String)</a>
  </div>
  <h3 id="seealso">See Also</h3>
  <div class="seealso">
      <div><span class="xref">System.Collections.Generic.IReadOnlyDictionary</span>&lt;TKey, TValue&gt;</div>
      <div><span class="xref">System.Collections.Generic.IReadOnlyDictionary</span>&lt;TKey, TValue&gt;</div>
      <div><a class="xref" href="SpiceSharp.Simulations.IVariable.html">IVariable</a></div>
  </div>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
            
            <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>
